<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.8"/>
<title>NGUI: Next-Gen UI kit: UISpriteAnimation Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">NGUI: Next-Gen UI kit
   &#160;<span id="projectnumber">3.7.2</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.8 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Packages</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('class_u_i_sprite_animation.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Properties</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Macros</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="class_u_i_sprite_animation-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">UISpriteAnimation Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Very simple sprite animation. Attach to a sprite and specify a common prefix such as "idle" and it will cycle through them.  
 <a href="class_u_i_sprite_animation.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for UISpriteAnimation:</div>
<div class="dyncontent">
 <div class="center">
  <img src="class_u_i_sprite_animation.png" usemap="#UISpriteAnimation_map" alt=""/>
  <map id="UISpriteAnimation_map" name="UISpriteAnimation_map">
</map>
 </div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a8605b298c23abaf132babc87ef4df4c5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_sprite_animation.html#a8605b298c23abaf132babc87ef4df4c5">RebuildSpriteList</a> ()</td></tr>
<tr class="memdesc:a8605b298c23abaf132babc87ef4df4c5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Rebuild the sprite list after changing the sprite name.  <a href="#a8605b298c23abaf132babc87ef4df4c5">More...</a><br /></td></tr>
<tr class="separator:a8605b298c23abaf132babc87ef4df4c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac79d13aa7cf8b4a361b2191640d34191"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_sprite_animation.html#ac79d13aa7cf8b4a361b2191640d34191">Play</a> ()</td></tr>
<tr class="memdesc:ac79d13aa7cf8b4a361b2191640d34191"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset the animation to the beginning.  <a href="#ac79d13aa7cf8b4a361b2191640d34191">More...</a><br /></td></tr>
<tr class="separator:ac79d13aa7cf8b4a361b2191640d34191"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab081b4e98b15ebd3fbbe9c6419ac68a7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_sprite_animation.html#ab081b4e98b15ebd3fbbe9c6419ac68a7">Pause</a> ()</td></tr>
<tr class="memdesc:ab081b4e98b15ebd3fbbe9c6419ac68a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pause the animation.  <a href="#ab081b4e98b15ebd3fbbe9c6419ac68a7">More...</a><br /></td></tr>
<tr class="separator:ab081b4e98b15ebd3fbbe9c6419ac68a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acfa8c2a262dafec27cc130b973c38e5e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_sprite_animation.html#acfa8c2a262dafec27cc130b973c38e5e">ResetToBeginning</a> ()</td></tr>
<tr class="memdesc:acfa8c2a262dafec27cc130b973c38e5e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset the animation to frame 0 and activate it.  <a href="#acfa8c2a262dafec27cc130b973c38e5e">More...</a><br /></td></tr>
<tr class="separator:acfa8c2a262dafec27cc130b973c38e5e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:aad343d1aab0112463531a66d339e22f4"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_sprite_animation.html#aad343d1aab0112463531a66d339e22f4">Start</a> ()</td></tr>
<tr class="memdesc:aad343d1aab0112463531a66d339e22f4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Rebuild the sprite list first thing.  <a href="#aad343d1aab0112463531a66d339e22f4">More...</a><br /></td></tr>
<tr class="separator:aad343d1aab0112463531a66d339e22f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac23b7707bf0c4255f7ffe30462b92f3f"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_sprite_animation.html#ac23b7707bf0c4255f7ffe30462b92f3f">Update</a> ()</td></tr>
<tr class="memdesc:ac23b7707bf0c4255f7ffe30462b92f3f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Advance the sprite animation process.  <a href="#ac23b7707bf0c4255f7ffe30462b92f3f">More...</a><br /></td></tr>
<tr class="separator:ac23b7707bf0c4255f7ffe30462b92f3f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a498a21bad89dfd053d79b53364cd68f3"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_sprite_animation.html#a498a21bad89dfd053d79b53364cd68f3">mFPS</a> = 30</td></tr>
<tr class="separator:a498a21bad89dfd053d79b53364cd68f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac1cf7db10cb613d516e8d569a1c4ed33"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_sprite_animation.html#ac1cf7db10cb613d516e8d569a1c4ed33">mPrefix</a> = &quot;&quot;</td></tr>
<tr class="separator:ac1cf7db10cb613d516e8d569a1c4ed33"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaab49577e03f5c952d98c3f13ba3782d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_sprite_animation.html#aaab49577e03f5c952d98c3f13ba3782d">mLoop</a> = true</td></tr>
<tr class="separator:aaab49577e03f5c952d98c3f13ba3782d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa27d235c244e003da76071750365b0c0"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_sprite_animation.html#aa27d235c244e003da76071750365b0c0">mSnap</a> = true</td></tr>
<tr class="separator:aa27d235c244e003da76071750365b0c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a10653d55baed2837a40430ed09080922"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_u_i_sprite.html">UISprite</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_sprite_animation.html#a10653d55baed2837a40430ed09080922">mSprite</a></td></tr>
<tr class="separator:a10653d55baed2837a40430ed09080922"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa9f8d631e9491c7997cc82825cf95e7e"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_sprite_animation.html#aa9f8d631e9491c7997cc82825cf95e7e">mDelta</a> = 0f</td></tr>
<tr class="separator:aa9f8d631e9491c7997cc82825cf95e7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab57d1a219f6356b0d4f5b87e3527fb04"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_sprite_animation.html#ab57d1a219f6356b0d4f5b87e3527fb04">mIndex</a> = 0</td></tr>
<tr class="separator:ab57d1a219f6356b0d4f5b87e3527fb04"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9ebeabe682a4c954d279fbd441725d2e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_sprite_animation.html#a9ebeabe682a4c954d279fbd441725d2e">mActive</a> = true</td></tr>
<tr class="separator:a9ebeabe682a4c954d279fbd441725d2e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1bc09446a407f6071b1001f8f4f9554c"><td class="memItemLeft" align="right" valign="top">List&lt; string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_sprite_animation.html#a1bc09446a407f6071b1001f8f4f9554c">mSpriteNames</a> = new List&lt;string&gt;()</td></tr>
<tr class="separator:a1bc09446a407f6071b1001f8f4f9554c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
Properties</h2></td></tr>
<tr class="memitem:a1e8ebf33f292bb960e5c5d42dc452ad6"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_sprite_animation.html#a1e8ebf33f292bb960e5c5d42dc452ad6">frames</a><code> [get]</code></td></tr>
<tr class="memdesc:a1e8ebf33f292bb960e5c5d42dc452ad6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of frames in the animation.  <a href="#a1e8ebf33f292bb960e5c5d42dc452ad6">More...</a><br /></td></tr>
<tr class="separator:a1e8ebf33f292bb960e5c5d42dc452ad6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abf958ea8f66a9f2193cae3dd556ae764"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_sprite_animation.html#abf958ea8f66a9f2193cae3dd556ae764">framesPerSecond</a><code> [get, set]</code></td></tr>
<tr class="memdesc:abf958ea8f66a9f2193cae3dd556ae764"><td class="mdescLeft">&#160;</td><td class="mdescRight">Animation framerate.  <a href="#abf958ea8f66a9f2193cae3dd556ae764">More...</a><br /></td></tr>
<tr class="separator:abf958ea8f66a9f2193cae3dd556ae764"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1b3b06151ce86c165604baa2695a8d5b"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_sprite_animation.html#a1b3b06151ce86c165604baa2695a8d5b">namePrefix</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a1b3b06151ce86c165604baa2695a8d5b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the name prefix used to filter sprites from the atlas.  <a href="#a1b3b06151ce86c165604baa2695a8d5b">More...</a><br /></td></tr>
<tr class="separator:a1b3b06151ce86c165604baa2695a8d5b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a641fdbb84a2ddfb80a06d40cc9c0cef2"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_sprite_animation.html#a641fdbb84a2ddfb80a06d40cc9c0cef2">loop</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a641fdbb84a2ddfb80a06d40cc9c0cef2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the animation to be looping or not  <a href="#a641fdbb84a2ddfb80a06d40cc9c0cef2">More...</a><br /></td></tr>
<tr class="separator:a641fdbb84a2ddfb80a06d40cc9c0cef2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aac92b5f7c772ea71bfb2249e418d1ecf"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_sprite_animation.html#aac92b5f7c772ea71bfb2249e418d1ecf">isPlaying</a><code> [get]</code></td></tr>
<tr class="memdesc:aac92b5f7c772ea71bfb2249e418d1ecf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns is the animation is still playing or not  <a href="#aac92b5f7c772ea71bfb2249e418d1ecf">More...</a><br /></td></tr>
<tr class="separator:aac92b5f7c772ea71bfb2249e418d1ecf"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Very simple sprite animation. Attach to a sprite and specify a common prefix such as "idle" and it will cycle through them. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ab081b4e98b15ebd3fbbe9c6419ac68a7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void UISpriteAnimation.Pause </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Pause the animation. </p>

</div>
</div>
<a class="anchor" id="ac79d13aa7cf8b4a361b2191640d34191"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void UISpriteAnimation.Play </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Reset the animation to the beginning. </p>

</div>
</div>
<a class="anchor" id="a8605b298c23abaf132babc87ef4df4c5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void UISpriteAnimation.RebuildSpriteList </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Rebuild the sprite list after changing the sprite name. </p>

</div>
</div>
<a class="anchor" id="acfa8c2a262dafec27cc130b973c38e5e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void UISpriteAnimation.ResetToBeginning </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Reset the animation to frame 0 and activate it. </p>

</div>
</div>
<a class="anchor" id="aad343d1aab0112463531a66d339e22f4"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void UISpriteAnimation.Start </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Rebuild the sprite list first thing. </p>

</div>
</div>
<a class="anchor" id="ac23b7707bf0c4255f7ffe30462b92f3f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void UISpriteAnimation.Update </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Advance the sprite animation process. </p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a9ebeabe682a4c954d279fbd441725d2e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool UISpriteAnimation.mActive = true</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="aa9f8d631e9491c7997cc82825cf95e7e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">float UISpriteAnimation.mDelta = 0f</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="a498a21bad89dfd053d79b53364cd68f3"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">int UISpriteAnimation.mFPS = 30</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="ab57d1a219f6356b0d4f5b87e3527fb04"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">int UISpriteAnimation.mIndex = 0</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="aaab49577e03f5c952d98c3f13ba3782d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool UISpriteAnimation.mLoop = true</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="ac1cf7db10cb613d516e8d569a1c4ed33"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">string UISpriteAnimation.mPrefix = &quot;&quot;</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="aa27d235c244e003da76071750365b0c0"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool UISpriteAnimation.mSnap = true</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="a10653d55baed2837a40430ed09080922"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_u_i_sprite.html">UISprite</a> UISpriteAnimation.mSprite</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="a1bc09446a407f6071b1001f8f4f9554c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">List&lt;string&gt; UISpriteAnimation.mSpriteNames = new List&lt;string&gt;()</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a class="anchor" id="a1e8ebf33f292bb960e5c5d42dc452ad6"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">int UISpriteAnimation.frames</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Number of frames in the animation. </p>

</div>
</div>
<a class="anchor" id="abf958ea8f66a9f2193cae3dd556ae764"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">int UISpriteAnimation.framesPerSecond</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Animation framerate. </p>

</div>
</div>
<a class="anchor" id="aac92b5f7c772ea71bfb2249e418d1ecf"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool UISpriteAnimation.isPlaying</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Returns is the animation is still playing or not </p>

</div>
</div>
<a class="anchor" id="a641fdbb84a2ddfb80a06d40cc9c0cef2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool UISpriteAnimation.loop</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Set the animation to be looping or not </p>

</div>
</div>
<a class="anchor" id="a1b3b06151ce86c165604baa2695a8d5b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">string UISpriteAnimation.namePrefix</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Set the name prefix used to filter sprites from the atlas. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>D:/Projects/NGUI/Assets/NGUI/Scripts/UI/<a class="el" href="_u_i_sprite_animation_8cs.html">UISpriteAnimation.cs</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="class_u_i_sprite_animation.html">UISpriteAnimation</a></li>
    <li class="footer">Generated on Sat Sep 13 2014 05:29:19 for NGUI: Next-Gen UI kit by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.8 </li>
  </ul>
</div>
</body>
</html>
